/
AbstractConfidentialClientAcquireTokenParameterBuilder`1.xml
141 lines (141 loc) · 8.92 KB
/
AbstractConfidentialClientAcquireTokenParameterBuilder`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<Type Name="AbstractConfidentialClientAcquireTokenParameterBuilder<T>" FullName="Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<T>">
<TypeSignature Language="C#" Value="public abstract class AbstractConfidentialClientAcquireTokenParameterBuilder<T> : Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder<T> where T : AbstractAcquireTokenParameterBuilder<T>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit AbstractConfidentialClientAcquireTokenParameterBuilder`1<(class Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1<!T>) T> extends Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1<!T>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class AbstractConfidentialClientAcquireTokenParameterBuilder(Of T)
Inherits AbstractAcquireTokenParameterBuilder(Of T)" />
<TypeSignature Language="F#" Value="type AbstractConfidentialClientAcquireTokenParameterBuilder<'T (requires 'T :> AbstractAcquireTokenParameterBuilder<'T>)> = class
 inherit AbstractAcquireTokenParameterBuilder<'T (requires 'T :> AbstractAcquireTokenParameterBuilder<'T>)>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<BaseTypeName>Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder<T></BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder<T></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">T</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<typeparam name="T" />
<summary>
Base class for confidential client application token request builders
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ExecuteAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> ExecuteAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> ExecuteAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ExecuteAsync (cancellationToken As CancellationToken) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="override this.ExecuteAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="abstractConfidentialClientAcquireTokenParameterBuilder.ExecuteAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="protected override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.Validate" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="abstractConfidentialClientAcquireTokenParameterBuilder.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validates the parameters of the AcquireToken operation.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalClientException" />
</Docs>
</Member>
<Member MemberName="WithProofOfPossession">
<MemberSignature Language="C#" Value="public T WithProofOfPossession (Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration popAuthenticationConfiguration);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !T WithProofOfPossession(class Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration popAuthenticationConfiguration) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.WithProofOfPossession(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration)" />
<MemberSignature Language="VB.NET" Value="Public Function WithProofOfPossession (popAuthenticationConfiguration As PoPAuthenticationConfiguration) As T" />
<MemberSignature Language="F#" Value="member this.WithProofOfPossession : Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration -> 'T" Usage="abstractConfidentialClientAcquireTokenParameterBuilder.WithProofOfPossession popAuthenticationConfiguration" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="popAuthenticationConfiguration" Type="Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration" />
</Parameters>
<Docs>
<param name="popAuthenticationConfiguration">Configuration properties used to construct a Proof-of-Possession request.</param>
<summary>
Modifies the token acquisition request so that the acquired token is a Proof-of-Possession token (PoP), rather than a Bearer token.
PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage on Windows.
See https://aka.ms/msal-net-pop
</summary>
<returns>The builder.</returns>
<remarks>
<list type="bullet">
<item>
<description>An Authentication header is automatically added to the request.</description>
</item>
<item>
<description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description>
</item>
<item>
<description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description>
</item>
<item>
<description>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</description>
</item>
</list>
</remarks>
</Docs>
</Member>
</Members>
</Type>